Skip to content

Util, io, ref (8): filled in @param, @tparam, and @return tags that were missed last time#26127

Open
bvenners wants to merge 1 commit into
scala:mainfrom
artimahub:scaladoc-tags-util-io-ref-cleanup
Open

Util, io, ref (8): filled in @param, @tparam, and @return tags that were missed last time#26127
bvenners wants to merge 1 commit into
scala:mainfrom
artimahub:scaladoc-tags-util-io-ref-cleanup

Conversation

@bvenners
Copy link
Copy Markdown
Contributor

As a next step in improving the Scaladoc documentation for the Scala 3 standard library, this PR fills in @param, @tparam, and @return tags for scala.util, scala.io, and scala.ref that were missed in the previous batch of PRs. I'm submitting it as a draft PR so to get CI to run on it, to see if it breaks anything, and to start getting feedback. We automated the generation of these changes and are starting to review them. We will review them all before making the PR non-draft. Please let me know if you see anything specific that you think could be improved.

Copy link
Copy Markdown
Contributor

@cheeseng cheeseng left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added some suggestions.

Comment thread library/src/scala/io/Position.scala Outdated
Comment thread library/src/scala/io/Position.scala Outdated
Comment thread library/src/scala/util/Random.scala
@cheeseng cheeseng force-pushed the scaladoc-tags-util-io-ref-cleanup branch from 4580d88 to 249e26f Compare May 23, 2026 14:14
@bvenners bvenners force-pushed the scaladoc-tags-util-io-ref-cleanup branch 2 times, most recently from fed7412 to 53f2c11 Compare May 31, 2026 21:45
@bvenners bvenners force-pushed the scaladoc-tags-util-io-ref-cleanup branch from 53f2c11 to 945b2b9 Compare June 1, 2026 05:44
@bvenners bvenners marked this pull request as ready for review June 1, 2026 05:44
@bvenners bvenners requested a review from a team as a code owner June 1, 2026 05:44
@SethTisue
Copy link
Copy Markdown
Member

@bvenners is the CI failure related to your changes?

@bvenners
Copy link
Copy Markdown
Contributor Author

bvenners commented Jun 2, 2026

@bvenners is the CI failure related to your changes?

Possibly. We will check into those tonight.

See: #26125 (comment)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants